docs: simplify setup guide and modernize SDK instructions #2004
Conversation
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
How to use the Graphite Merge QueueAdd the label merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Merge activity
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR simplifies the setup documentation by transitioning from Deno to Node.js-based tooling and modernizing SDK instructions for better developer experience.
- Removed Deno runtime dependency in favor of
tsxfor running tests in/site/src/content/docs/setup.mdx - Added package manager-specific installation instructions (npm, pnpm, yarn, bun) for
@rivet-gg/actor-client - Streamlined introduction and removed redundant editor/IDE setup section
- Potential issue: May need additional setup instructions for
tsxcommand compatibility
1 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
| After initializing your project, now you will deploy your actor to Rivet's servers. | ||
|
|
||
| Run the following command, and replace `my-app` with the name of your project: | ||
| After initializing your project, will deploy your actor to Rivet's servers: |
There was a problem hiding this comment.
syntax: Grammar error in this sentence - 'will deploy' should be 'we will deploy' or 'you will deploy'
| After initializing your project, will deploy your actor to Rivet's servers: | |
| After initializing your project, you will deploy your actor to Rivet's servers: |
|
|
||
| ```sh | ||
| rivet deno run -A counter_test.ts | ||
| npx tsx counter_test.ts |
There was a problem hiding this comment.
logic: Missing prerequisite instructions for installing tsx and setting up Node.js environment before running this command
<!-- Please make sure there is an issue that this PR is correlated to. --> ## Changes <!-- If there are frontend changes, please include screenshots. -->
graphite-app
bot
deleted the branch
02-07-fix_cli_auto-generate_.yarnrc.yml_to_disable_pnp_for_tsx_support
graphite-app
bot
deleted the
docs_simplify_setup_guide_and_modernize_SDK_instructions
branch
Changes